/* 
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.  
 */
package erwiki.api.authorization.login;

import javax.security.auth.callback.Callback;
import javax.servlet.http.HttpServletRequest;

/**
 * Callback for requesting and supplying a HttpServletRequest required by a LoginModule. This Callback is used
 * by LoginModules needing access to the servlet request.
 * 
 * @see javax.servlet.http.HttpServletRequest#getUserPrincipal() or
 * @see javax.servlet.http.HttpServletRequest#getRemoteUser() methods.
 * @since 2.3
 */
public class HttpRequestCallback implements Callback {

	private HttpServletRequest m_request;

	/**
	 * Sets the request object. CallbackHandler objects call this method..
	 * 
	 * @param request
	 *            the servlet request
	 */
	public void setRequest(HttpServletRequest request) {
		this.m_request = request;
	}

	/**
	 * Returns the request object. LoginModules call this method after a CallbackHandler sets the request.
	 * 
	 * @return the servlet request
	 */
	public HttpServletRequest getRequest() {
		return this.m_request;
	}

}
